home *** CD-ROM | disk | FTP | other *** search
/ CD Exchange / CD Exchange - Volume 1.iso / utils / misc / isam / isamerrors.doc < prev    next >
Encoding:
Text File  |  1993-11-29  |  10.9 KB  |  290 lines
  1.  
  2.                       ================================
  3.                       = SOME COMMENTS ON ERROR CODES =
  4.                       ================================
  5.  
  6. ERROR_BLANK_LINE
  7.    - This is returned when a blank line is found where a data/index file
  8.      name was expected.
  9.  
  10. ERROR_CANNOT_DELETE_DATA_FILE
  11. ERROR_CANNOT_DELETE_INDEX_FILE
  12.    - These are returned from DeleteISAMFile.
  13.  
  14. ERROR_CANNOT_SET_ONEXIT
  15.    - this is returned from the first function attempted, if for some reason
  16.      the exit trap couldn't be set. [OBSOLETE - WILL NOT BE RETURNED]
  17.  
  18. ERROR_CONFLICTING_UorR
  19.    - this is returned from CreateISAMFile and ReIndexISAMFile.
  20.      Two or more keys have the same offset and size, but one is designated
  21.      as unique, and the other repeatable.  This is not possible.
  22.  
  23. ERROR_DATA_END_OF_FILE
  24.    - This shouldn't happen (and probably should be an Internal Error).
  25.  
  26. ERROR_DATA_FILE_NOT_FOUND
  27.    - This is returned from OpenISAMFile.
  28.  
  29. ERROR_DELETED_RECORD
  30.    - This is returned from ReadISAMRecord, ModifyISAMRecord,
  31.      DeleteISAMRecord, LockISAMRecord and UnLockISAMRecord.
  32.      The RecNo supplied refers to a deleted record.
  33.  
  34. ERROR_FILE_ALREADY_OPEN
  35.    - This is returned from OpenISAMFile.
  36.      The user has the file open already, but tried to open it again.
  37.  
  38. ERROR_FILE_IN_USE
  39.    - This is returned from CreateISAMFile, ReIndexISAMFile, and
  40.      DeleteISAMFile.
  41.      An ISAM file may not be Created, ReIndexed, or Deleted if another
  42.      user has the file open.
  43.  
  44. ERROR_FILE_LOCKED
  45.    - Another user has the file locked in a mode incompatible with the
  46.      current function.
  47.  
  48. ERROR_FILE_NOT_OPEN
  49.    - This is returned from any function that deals with a specific file,
  50.      when that file has not been opened by the user calling that function.
  51.  
  52. ERROR_FROM_KEY_MISSING
  53. ERROR_FROM_KEY_PRESENT
  54.    - These are returned from SetUpISAMIterationRange.
  55.      The iteration type specifies that the From key should/shouldn't be
  56.      present, and it wasn't/was.
  57.  
  58. ERROR_INCOMPLETE_KEY_LINE
  59.    - This is returned from CreateISAMFile and ReIndexISAMFile.
  60.      A key specification line in the Specs File is missing some
  61.      necessary information.
  62.  
  63. ERROR_INCOMPLETE_PATH
  64.    - This is returned from CreateISAMFile and ReIndexISAMFile.
  65.      The data and index files must have fully specified paths.
  66.      That is, they must have a ":" in the path (preceded by either a
  67.      [logical] device or volume name).
  68.  
  69. ERROR_INDEX_FILE_NOT_FOUND
  70.    - This is returned from OpenISAMFile.
  71.  
  72. ERROR_INSUFFICIENT_MEMORY
  73.    - This is returned from almost everywhere.
  74.      
  75. ERROR_INVALID_AorD
  76.    - This is returned from CreateISAMFile and ReIndexISAMFile.
  77.      Either some intervening specification was left out, or
  78.      the Ascending/Descending character was not "A" or "D".
  79.  
  80. ERROR_INVALID_DATA_FILE
  81.    - This is returned from OpenISAMFile.
  82.      An index file was listed where the data file was supposed to be.
  83.      (The first line of the specs file is where the data file is listed.
  84.      The second line is for the index file.)
  85.  
  86. ERROR_INVALID_DATA_FILE_SIZE
  87.    - This is returned from ReadISAMRecord, ModifyISAMRecord,
  88.      DeleteISAMRecord, and ReIndexISAMRecord.
  89.      Only a partial read was possible, indicating that the data file size
  90.      was not an even multiple of the record size (+1).
  91.      For Read/Modify/Delete, this may indicate trouble.
  92.      For ReIndex, it may just mean that an attempt was made to change the
  93.      record size, which ReIndex can't do.
  94.  
  95. ERROR_INVALID_INDEX_FILE
  96.    - This is returned from OpenISAMFile.
  97.      A data file (or some non-ISAM-related file) was listed where the
  98.      index file was supposed to be.
  99.      (The first line of the specs file is where the data file is listed.
  100.      The second line is for the index file.)
  101.  
  102. ERROR_INVALID_ITERATION_TYPE
  103.    - This is returned from SetUpISAMIterationRange.
  104.      Valid types are: 0 - 9.
  105.  
  106. ERROR_INVALID_KEY_LENGTH
  107.    - This is returned from CreateISAMFile and ReIndexISAMFile.
  108.      The key length was not a number, or is invalid for the key type,
  109.      or a key length was larger than the maximum possible size (499),
  110.      or the key length + key offset yields an amount larger than the
  111.      record length.
  112.  
  113. ERROR_INVALID_KEY_OFFSET
  114.    - This is returned from CreateISAMFile and ReIndexISAMFile.
  115.      The key offset was not a number, or is beyond the end of the record.
  116.      The key offset must be less than the record size.
  117.  
  118. ERROR_INVALID_KEY_TYPE
  119.    - This is returned from CreateISAMFile and ReIndexISAMFile.
  120.      Either some intervening specification was left out, or the type is
  121.      invalid.
  122.      Valid types are: A, T, C, I, F.
  123.    - This is also called from SetUpISAMIterationPrefix, if the key is
  124.      not type A, T, or UI.
  125.  
  126. ERROR_INVALID_LOCK_TYPE
  127.    - This is returned from LockISAMRecord, LockISAMFile, StoreISAMRecord,
  128.      OpenISAMFile, ReadISAMRecord, ReadUniqueISAMRecord, ReadNextISAMRecord.
  129.      Valid types are: R, W.
  130.  
  131. ERROR_INVALID_PREFIX_LENGTH
  132.    - This is returned from SetUpISAMIterationPrefix.
  133.      Either the prefix length specified is longer than the key length,
  134.      or the prefix length specified is zero, and strlen( prefix ) is
  135.      longer than the key length.
  136.  
  137. ERROR_INVALID_RECORD_LENGTH
  138.    - This is called from CreateISAMFile and ReIndexISAMFile.
  139.      Either the record size was not a number, or was less than 4.
  140.      A record must be at least 4 bytes in length.
  141.  
  142. ERROR_INVALID_UorR
  143.    - This is returned from CreateISAMFile and ReIndexISAMFile.
  144.      Either some intervening specification was left out, or
  145.      the Unique/Repeatable character was not "U" or "R".
  146.  
  147. ERROR_ISAM_ALREADY_INSTALLED
  148.    - This is returned from an attempted second installation of ISAM.
  149.      ISAM may only be installed once in memory.
  150.  
  151. ERROR_ISAM_NOT_INSTALLED
  152.    - This is returned from any function.
  153.      ISAM is not installed.
  154.  
  155. ERROR_ISAM_SHUTTING_DOWN
  156.    - This is returned from any function.
  157.      Someone is in the process of shutting down ISAM.
  158.      All functions already waiting for ISAM's attention return this after
  159.      ISAM receives the command to shut down.
  160.  
  161. ERROR_KEY_IS_ASCENDING
  162. ERROR_KEY_IS_DESCENDING
  163.    - This is returned from SetUpISAMIterationRange.
  164.      Either the From Key is after the To Key and the key is an ascending key,
  165.      or the From Key is before the To Key and the key is a descending key.
  166.      Either way, the From Key and To Key are in the wrong order.
  167.  
  168. ERROR_KEY_LINE_TOO_LONG
  169.    - This is returned from CreateISAMFile and ReIndexISAMFile.
  170.      After all necessary information was obtained from a key line, there were
  171.      still characters left over.
  172.  
  173. ERROR_KEY_NOT_UNIQUE
  174.    - This is returned from ReadUniqueISAMRecord.
  175.      The key number indicated referred to a Repeatable key.
  176.  
  177. ERROR_MAX_FILES_OPEN
  178.    - This is returned from OpenISAMFile.
  179.      The maximum number of different ISAM files that can be open, are open
  180.      and a request to open another one was made.
  181.      Specify a higher maximum the next time ISAM is installed.
  182.  
  183. ERROR_NO_FREE_SIGNALS
  184.    - This is returned from the first function attempted.
  185.      In order to communicate with the server, a message port has to be set
  186.      up, with a signal bit allocated from the user's task.  If there are
  187.      no more free signals available, this error is returned.
  188.      This is not likely, as there are 16 user signals per task.
  189.  
  190. ERROR_NO_KEY_INFO
  191.    - This is returned from CreateISAMFile and ReIndexISAMFile.
  192.      There were no keys specified in the Specs File.
  193.  
  194. ERROR_NO_MORE_RECORDS
  195.    - This is returned from ReadNextISAMRecord and ReadNextISAMKey.
  196.      This is not an error.
  197.      The iteration SetUp previously is over - no more records meet the
  198.      SetUp criteria.
  199.  
  200. ERROR_NO_SUCH_KEY
  201.    - This is returned from any function with a key number parameter.
  202.      There is no such key for the given file.
  203.  
  204. ERROR_NO_SUCH_RECORD
  205.    - This is returned from ReadUniqueISAMRecord.
  206.      No record with the key value specified exists in the file.
  207.  
  208. ERROR_NULL_POINTER
  209.    - This is returned whenever a pointer to something is given as
  210.      a paramter.
  211.      The pointer contained the value NULL, and thus was invalid.
  212.  
  213. ERROR_PARM_COUNT_MISMATCH
  214.    - This is returned from [Dis]AssembleRecord when the number of types
  215.      in the type string differs from the number of variables in the
  216.      variable string [or the number of formats in the format string].
  217.      ARexx only.
  218.  
  219. ERROR_RECORDS_LOCKED
  220.    - This is returned from OpenISAMRecord.
  221.      The attempt to open the file failed because the user wanted the
  222.      file locked, and another user had records in that file locked.
  223.  
  224. ERROR_RECORD_EXISTS
  225.    - This is returned from StoreISAMRecord and ModifyISAMRecord.
  226.      This file has a unique key, and a search of the file showed that
  227.      a record already exists in the file with the same key value as the
  228.      record that the user is attempting to Store/Modify.
  229.  
  230. ERROR_RECORD_LOCKED
  231.    - Another user has the record locked in a mode incompatible with the
  232.      current function.
  233.  
  234. ERROR_RECORD_TOO_HIGH
  235.    - This is returned from ReadISAMRecord, ModifyISAMRecord,
  236.      DeleteISAMRecord, LockISAMRecord and UnLockISAMRecord.
  237.      The RecNo supplied refers to a position beyond the end of the data file.
  238.  
  239. ERROR_RENAME_FAILED_IN_REINDEX
  240.    - This is returned from ReIndexISAMFile.
  241.      ReIndex calls Create to make the index file.  Create deletes both
  242.      data and index files, if they exist.  Therefore, ReIndex first
  243.      renames the data file.  Afterwards, it renames it back.
  244.      (In between, it deletes the newly Created (empty) data file, so that
  245.      the rename of the already-existing data file back to the old name can
  246.      succeed.)
  247.      Here, one of the renames, or the delete failed for some reason.
  248.  
  249. ERROR_SPECS_FILE_EMPTY
  250.    - This is returned from CreateISAMFile and ReIndexISAMFile.
  251.      There was nothing specified beyond the data/index file names in 
  252.      the Specs File.
  253.  
  254. ERROR_TO_KEY_MISSING
  255. ERROR_TO_KEY_PRESENT
  256.    - These are returned from SetUpISAMIterationRange.
  257.      The iteration type specifies that the To key should/shouldn't be
  258.      present, and it wasn't/was.
  259.  
  260.  
  261.  
  262.     --------------------------------------------------------------
  263.      the following are INTERNAL errors (note the "I") and are
  264.      unlikely to be returned.  If they are, report them to us.
  265.      Copy the problem specs/data/index files onto a floppy disk,
  266.      and jot down a note (file or paper) providing the name and
  267.      parameter values of the function that returned the error,
  268.      along with a copy of the ISAMStatus report, and ISAMFileReport
  269.      for the problem file, both run immediately after the error.
  270.  
  271.      After copying the files/reports/function description onto the
  272.      floppy, run ReIndex on the file.  The problem may just go away.
  273.      Do let us know about it, in any case.  If we don't know about
  274.      bugs, we can't fix them!
  275.     --------------------------------------------------------------
  276.  
  277. IERROR_DELETED_KEYNODE
  278. IERROR_HEADER_KEYNODE
  279. IERROR_INDEX_END_OF_FILE
  280. IERROR_INVALID_AorD
  281. IERROR_INVALID_INDEX_FILE_SIZE
  282. IERROR_INVALID_ISAM_COMMAND
  283. IERROR_KEYNODE_TOO_HIGH
  284. IERROR_KEY_VALUE_NOT_FOUND
  285. IERROR_NOT_DELETED_KEYNODE
  286. IERROR_NOT_DELETED_RECORD
  287. IERROR_NO_FFILE_FOR_TFILE
  288. IERROR_NO_RECORDS_IN_FILE
  289.  
  290.